Integrating Programs and Documentation
نویسنده
چکیده
A simple tool called PD system is described and offered for general use that allows one to integrate programs and their documentation in ASCII files. Such a program with documentation file (PD file) consists of alternating documentation and program sections. PD files can be compiled directly; for a compiler, documentation sections are just commentaries to be ignored. On the other hand, the PD system allows one to transform PD files into LaTeX source files and so to produce formatted documents. For the description of formatted material in the documentation sections, a simple markup language is offered. The main goal in the design of this language is readability of the source text. In other words, formatting specifications are kept as “implicit” and “invisible” as possible and much of the “formatting noise” occurring in LaTeX and other markup languages can be hidden. PD files should be readable for anyone without prior learning of the markup language. Independent from the problem of documenting programs, PD files may be convenient for describing text documents in ASCII files (rather than using LaTeX directly). The PD System was written in C using the lex and yacc tools. It is free software available from the author and includes its own documentation as a PD file.
منابع مشابه
Integrating Information Sources for Visualizing Java Programs
This paper describes the integration of information sources to support the exploration of source code and documentation of Java programs. There are many public domain tools that are available for extracting information and documentation from Java programs. We describe how data integration and presentation integration were used to enable the visualization of this information within a software ex...
متن کاملIntegrating a Hypertext Interface into a Syntax-Directed Programming Environment
This paper describes an integration of hypertext browsing and authoring facilities into a syntax-directed programming environment. The editor’s recognition of the programming language building blocks has been exploited not only to guide program entry, but to break programs into units which can be connected into a hyperdocument. Comments and documentation are separated from the actual program an...
متن کاملNursing Care and Documentation Assistant with an Electronic Nursing Management System in Neonatal Intensive Care Unit
Background: All nursing cares require decision-making, and the ability to make the best decisions impact upon the quality of nursing care. Moreover, authenticity and accuracy of the best cares may be questioned if not recorded and reported properly and in a standard manner. We aimed to design and implement an electronic nursing managementsystem and then evaluate satisfaction of nurses with the ...
متن کاملClinical Documentation in Emergency Departments : Integrating paper - based documentation into the electronic medical record
متن کامل
Integrating Software Security Into The Software Development Lifecycle
Applications make up the core of any system--for example small applications serving critical roles (e.g. Basic Input/Output System); word processors; firewalls; e-mail servers; and operating systems--and, as a result, applications must be written both in a secure fashion and with security in mind or they may become the weakest link, allowing the circumvention of various physical and logical acc...
متن کامل